home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / c / maker.com / MAKER.DOC < prev    next >
Encoding:
Text File  |  1991-06-09  |  19.5 KB  |  453 lines

  1.                        ████████████████████
  2.                        ██                ██
  3.                        ██     Maker      ██
  4.                        ██                ██
  5.                        ██  Version 1.02  ██
  6.                        ██                ██
  7.                        ████████████████████
  8.  
  9. ┌───────────────────────────────────────────────────────────────┐
  10. │ GENERAL                                                       │
  11. └───────────────────────────────────────────────────────────────┘
  12.  
  13.    This program generates MAKE description files & LINK files.  
  14. It designed for the Microsoft C compiler, but has enough 
  15. generality to be useful with other compilers as well.  To use the 
  16. program, enter: 
  17.  
  18.  
  19.      MAKER [files] [options]
  20.  
  21.  
  22. files  The source code files to process.  They must be in the 
  23.        current directory.  Wild cards (* and ?) are OK.  The 
  24.        default is *.C. 
  25.  
  26.  
  27. Options:
  28.  
  29.  
  30. /Ccmd  The compilation command.  The default is "CL /c".  If the 
  31.        command has embedded spaces, enclose the entire argument 
  32.        in double quotes. 
  33.  
  34. /Dfile The MAKE description file name.  The default is for the 
  35.        output file to be in the current directory, with the same 
  36.        name as the first source code file & an extension of 
  37.        "MAK." 
  38.  
  39. /Efile Is the executable file name.  The default is the base name 
  40.        of the first source code file, with an extension of "EXE." 
  41.  
  42. /Lfile Is the LINK file name.  A LINK file contains commands 
  43.        passed to the linker, & is invoked by LINK @filename.  The 
  44.        default file name, is the base name of the first source 
  45.        code file, with an extension of "LNK." 
  46.  
  47. /ND    Don't produce a MAKE description file ("no description 
  48.        file")
  49.  
  50. /NL    Don't produce a LINK file ("no LINK file")
  51.  
  52. /Oopts Link options.  If the options have embedded spaces, 
  53.        enclose the entire argument in double quotes. 
  54.  
  55. /P     Makes the program proceed even if it encounters errors 
  56.        reading a particular include file.  The default is to show 
  57.        an error message & abort.   If you use /P, an error 
  58.        message is still shown, but the program continues; it also 
  59.        includes an error notice in the MAKE description file.  
  60.        This parameter is especially useful if you are creating 
  61.        the MAKE description file for the first time and have a 
  62.        large number of source code files.  Using /P prevents you 
  63.        from having to rerun the program repetitively to correct 
  64.        missing include files.  You can run it once, correct any 
  65.        errors, then run it a second and final time. 
  66.  
  67. /Vvar  The environment variable telling where additional include 
  68.        files may be found.  The default is /VINCLUDE.  This 
  69.        option is useful if you put your include files in a 
  70.        separate directory. 
  71.  
  72. /Xpre  Ignore include files except those start with the specified 
  73.        prefix.  The default is to process all include files.  One 
  74.        use for the /X option is to ignore include files which are 
  75.        part of the standard library & thus never change.  To use 
  76.        the /X option this way, all other include file names would 
  77.        have to have a standard prefix.  You may repeat the /X 
  78.        option as many times as needed.  Prefixes must be no more 
  79.        than eight characters long. 
  80.  
  81.  
  82. EXAMPLE:
  83.  
  84.  
  85.    MAKER TEST?.C "/CCL /Od /Zi" /ETEST.EXE /OST:4000 /P /XFH /XRWA
  86.  
  87.  
  88. ┌───────────────────────────────────────────────────────────────┐
  89. │ HOW THE PROGRAM WORKS                                         │
  90. └───────────────────────────────────────────────────────────────┘
  91.  
  92.    Maker reads each source file, one at a time, to find what 
  93. files it includes.  It then reads each include file to see it it 
  94. has any further include files.  It displays the source file names 
  95. as it proceeds, then the include files, indented two spaces.  If 
  96. an include file has further include files, those will be further 
  97. indented, in a nested hierarchy. 
  98.  
  99.   The program assumes that all include files are in the same 
  100. directory as the source code files, or in directories specified 
  101. by the environment variable.  If an environment variable is used, 
  102. separate directory paths with semicolons.  For example, the 
  103. following environment variable: 
  104.  
  105.    INCLUDE=C:\C\INC;\FH\INC
  106.  
  107. causes Maker look for source code files in the current directory, 
  108. plus the directories C:\C\INC & \FH\INC. 
  109.  
  110.    When Maker finishes, you have both a MAKE description file and 
  111. a LINK file (unless you used /ND or /NL).  You may have to do 
  112. some additional editing on the files, if you want them in some 
  113. other format, or have additional items to add.  But the hard 
  114. part--defining the dependencies--has been done. 
  115.  
  116. ┌───────────────────────────────────────────────────────────────┐
  117. │ LIMITATIONS                                                   │
  118. └───────────────────────────────────────────────────────────────┘
  119.  
  120. ■  Maker was originally written for Microsoft C files.  However, 
  121.    it can be customized to some extent to accommodate other 
  122.    compilers as well.  The program requires MS-DOS or PC-DOS, 
  123.    version 2.0 or later. 
  124.  
  125. ■  Source code lines must be 511 characters or less.
  126.  
  127. ┌───────────────────────────────────────────────────────────────┐ 
  128. │ SYSTEM REQUIREMENTS                                           │ 
  129. └───────────────────────────────────────────────────────────────┘ 
  130.  
  131.     Maker requires MS-DOS or PC-DOS, version 2.0 or later.
  132.  
  133. ┌───────────────────────────────────────────────────────────────┐ 
  134. │ EXIT CODES                                                    │
  135. └───────────────────────────────────────────────────────────────┘
  136.  
  137.     Maker reports the following exit codes.  You can use these 
  138. with the ERRORLEVEL function in batch files (see your DOS manual 
  139. for details). 
  140.  
  141.     0  Normal termination
  142.     1  User aborted
  143.     2  Non-fatal error occurred during processing
  144.     3  Fatal error
  145.  
  146. ┌───────────────────────────────────────────────────────────────┐ 
  147. │ WHAT'S IN THIS PACKAGE                                        │
  148. └───────────────────────────────────────────────────────────────┘
  149.  
  150.     This package contains the following files:
  151.  
  152.     MAKER.EXE     Main program
  153.     MAKER.DOC     Documentation
  154.     REGISTER.DOC  Registration form
  155.     CATALOG.DOC   Catalog of other software available
  156.  
  157. ┌───────────────────────────────────────────────────────────────┐
  158. │ REVISION HISTORY                                              │
  159. └───────────────────────────────────────────────────────────────┘
  160.  
  161. 1.00  Original program
  162. 1.01  Fined tuned code to make it more compact 
  163.       Fixed bug so program would run on 8088 machines
  164. 1.02  Fixed minor bugs
  165.  
  166. ┌───────────────────────────────────────────────────────────────┐
  167. │ MESSAGES                                                      │
  168. └───────────────────────────────────────────────────────────────┘
  169.  
  170. Can't close file XXXXXX.  DOS wouldn't close the specified file, 
  171. so the contents are probably invalid. 
  172.  
  173. Can't find environment variable XXXXXX.  You specified a variable 
  174. with /V that is not in the current environment. 
  175.  
  176. Can't open file XXXXXX.  DOS couldn't read the specified file.  
  177. This usually has one of two causes.  First, there may be too many 
  178. files being open.  This usually indicates to many levels of 
  179. include nesting.  If this happens, try increasing the FILES= 
  180. statement in your CONFIG.SYS file.  If this doesn't solve the 
  181. problem, try rearranging your include file structure so it isn't 
  182. so heavily nested.   A second possible cause, if the file is an 
  183. output file, is that a previous version existed & is read only. 
  184.  
  185. Can't read file.  The program couldn't find the file.  Check your 
  186. environment variable to make sure it specifies the correct 
  187. directory.  If you want the program to proceed despite this type 
  188. of error, use /P. 
  189.  
  190. DOS 2.0 or later required.  You need PC-DOS or MS-DOS, version 
  191. 2.0 or later. 
  192.  
  193. Include file prefix too long.  It must be 8 characters or less. 
  194.  
  195. Insufficient memory.  Try deinstalling your RAM disk, TSR 
  196. programs, or getting more memory. 
  197.  
  198. Integer divide by 0.  This indicates a possible program bug.  
  199. Contact the author and tell him the circumstances under which you 
  200. saw this message. 
  201.  
  202. Invalid argument.  Check the instructions for the correct syntax. 
  203.  
  204. Invalid include directive:  XXXXX.  Include file names must be 
  205. enclosed with angle brackets (<>) or double quote marks ("").  
  206. The source code file that contains the invalid directive is shown 
  207. one or more lines above the error message. 
  208.  
  209. Not enough space for arguments.  You need more memory to run the 
  210. program. 
  211.  
  212. Not enough space for environment.  You need more memory to run 
  213. the program. 
  214.  
  215. Null pointer assignment.  This indicates a possible program bug.  
  216. Contact the author and tell him the circumstances under which you 
  217. saw this message. 
  218.  
  219. Program aborted.  You pressed Ctrl-Break or Ctrl-C, or asked the 
  220. program not to overwrite an existing file. 
  221.  
  222. Source files must be in current directory.  You specified a 
  223. different drive or directory. 
  224.  
  225. Stack overflow.  Either your include file nesting is too complex, 
  226. or you have circular inclusions (i.e., File A includes file B, 
  227. which includes File A, which includes File A, etc.). 
  228.  
  229. ┌───────────────────────────────────────────────────────────────┐
  230. │ MISCELLANY                                                    │
  231. └───────────────────────────────────────────────────────────────┘
  232.  
  233.  
  234.    You can redirect the keyboard input if desired.  This is 
  235. especially useful when updating description & LINK files in the 
  236. batch mode.  As an example, try the following: 
  237.  
  238.    ECHO YY | MAKER
  239.  
  240. ┌───────────────────────────────────────────────────────────────┐
  241. │ CREDITS                                                       │
  242. └───────────────────────────────────────────────────────────────┘
  243.  
  244.     Maker was written in C by Richard W. Adams.  It was developed 
  245. with PC-Write, version 3.02, & the Microsoft C Optimizing 
  246. Compiler, version 5.1. 
  247.  
  248.     The author is a member of the Association of Shareware 
  249. Professionals (ASP).  You may reach him at the address given in 
  250. REGISTER.DOC.  Should that address no longer be valid, try 
  251. contacting him through the ASP (545 Grover Road, Muskegon, MI 
  252. 49442).  He is also sometimes available on CompuServe 
  253. (76430,1071). 
  254.  
  255. ┌───────────────────────────────────────────────────────────────┐ 
  256. │ REGISTRATION                                                  │
  257. └───────────────────────────────────────────────────────────────┘
  258.  
  259.     Maker is copyright 1991 by Richard W. Adams, all rights 
  260. reserved.  The program is "shareware."  If you use Maker for more 
  261. than 30 days, you must register.  To do so, complete the 
  262. registration form in REGISTER.DOC & send it with a check for the 
  263. indicated amount to the author at the address on the form.
  264.  
  265. When you register, you receive:
  266.  
  267.     o The right to use your copy of Maker on a single computer. 
  268.  
  269.     o Free technical support by mail for three months.
  270.  
  271.     o Eligibility for free copies of future versions if you're 
  272.       the first to suggest improvements or report bugs that are 
  273.       fixed/incorporated in future versions. 
  274.  
  275.    Not only is registration a legal & ethical requirement, but 
  276. registration fees give shareware authors the incentive to develop 
  277. new software & improve old ones. 
  278.  
  279.     Tax exempt Christian religious organizations & churches are 
  280. eligible for free registration of Maker for official business.  
  281. Send a written request to the author, & you'll receive 
  282. registration forms.  The registration takes effect when you 
  283. complete return the forms.  This is a charitable donation. 
  284.  
  285.     Companies, government agencies & other organizations may 
  286. obtain site licenses for Maker, at greatly reduced unit costs.  
  287. Contact the author for details & a price list. 
  288.  
  289. ┌───────────────────────────────────────────────────────────────┐ 
  290. │ SHAREWARE                                                     │ 
  291. └───────────────────────────────────────────────────────────────┘ 
  292.  
  293.     Shareware distribution gives users a chance to try software 
  294. before buying it. If you try a Shareware program and continue 
  295. using it, you are expected to register.  Individual programs 
  296. differ on details--some request registration, others require it, 
  297. and some specify a maximum trial period.  With registration, you 
  298. get anything from the simple right to continue using the software 
  299. to an updated program with printed manual. 
  300.  
  301.     Copyright laws apply to both Shareware and commercial 
  302. software, and the copyright holder retains all rights, with a few 
  303. specific exceptions as stated below.  Shareware authors are 
  304. accomplished programmers, just like commercial authors, and the 
  305. programs are of comparable quality. (In both cases, there are 
  306. good programs and bad ones!)  The main difference is in the 
  307. method of distribution.  The author specifically grants the right 
  308. to copy and distribute the software, either to all and sundry or 
  309. to a specific group.  For example, some authors require written 
  310. permission before a commercial disk vendor may copy their 
  311. Shareware. 
  312.  
  313.     Shareware is a distribution method, not a type of software. 
  314. You should find software that suits your needs and pocketbook, 
  315. whether it's commercial or Shareware. The Shareware system makes 
  316. fitting your needs easier, because you can try before you buy. 
  317. And because the overhead is low, prices are low also. Shareware 
  318. has the ultimate money-back guarantee--if you don't use the 
  319. product, you don't pay for it. 
  320.  
  321. DISCLAIMER - AGREEMENT 
  322.  
  323.     Users of Maker must accept this disclaimer of warranty: 
  324. "Maker is supplied as is.  The author disclaims all warranties, 
  325. expressed or implied, including, without limitation, the 
  326. warranties of merchantability and of fitness for any purpose. The 
  327. author assumes no liability for damages, direct or consequential, 
  328. which may result from the use of Maker." 
  329.  
  330.     Maker is a Shareware program and is provided at no charge 
  331. for your evaluation.  Feel free to share it with your friends, 
  332. but please don't give it away altered or as part of another 
  333. system.  The essence of "user-supported" software is to provide 
  334. personal computer users with quality software without high 
  335. prices, and yet to provide incentive for programmers to continue 
  336. to develop new products.  If you find Maker useful and continue 
  337. to use it after a reasonable trial period, you must make a 
  338. registration payment of $10.00 to the author.  The $10.00 
  339. registration fee will license one copy for use on any one 
  340. computer at any one time.  You must treat this software just like 
  341. a book.  An example is that any number of people may use this 
  342. software and may freely move it from one computer location to 
  343. another, so long as there is no possibility of it being used at 
  344. one location while it's being used at another.  Just as two 
  345. different people can't read a book at the same time. 
  346.  
  347.     Commercial users of Maker must register and pay for their 
  348. copies of Maker within 30 days of first use or their license is 
  349. withdrawn.  Site-License arrangements may be made by contacting 
  350. the author. 
  351.  
  352.     Anyone distributing Maker for any kind of remuneration must 
  353. first contact the author for authorization. This authorization 
  354. will be automatically granted to distributors recognized by the 
  355. (ASP) as adhering to its guidelines for shareware distributors, 
  356. and such distributors may begin offering Maker immediately. 
  357. (However, you must still advise the author so the distributor can 
  358. be kept up-to-date with the latest version of Maker.) 
  359.  
  360.     You are encouraged to pass a copy of Maker to your friends 
  361. for evaluation.  Please encourage them to register their copy if 
  362. they find that they can use it.
  363.  
  364. ┌───────────────────────────────────────────────────────────────┐ 
  365. │ COPYING                                                       │ 
  366. └───────────────────────────────────────────────────────────────┘ 
  367.  
  368. You may copy & distribute Maker freely, as long as you:
  369.  
  370.     o Don't distribute it for commercial purposes without written 
  371.       permission from the author. 
  372.  
  373.     o Don't rent or lease it.
  374.  
  375.     o Include all constituent files.
  376.  
  377.     o Don't change the software or documentation.
  378.  
  379.     o Charge no fee other than a nominal one to cover distribution 
  380.       costs.
  381.  
  382. ┌───────────────────────────────────────────────────────────────┐ 
  383. │ OMBUDSMAN                                                     │ 
  384. └───────────────────────────────────────────────────────────────┘ 
  385.  
  386.     The author is a member of the Association of Shareware 
  387. Professionals (ASP).  ASP wants to make sure that the shareware 
  388. principle works for you. If you can't resolve a shareware related 
  389. problem with an ASP member by contacting the member directly, ASP 
  390. may be able to help.  The ASP Ombudsman can help you resolve a 
  391. dispute or problem with an ASP member, but does not provide 
  392. technical support for members' products.  Please write to the ASP 
  393. Ombudsman at 545 Grover Road, Muskegon, MI 49442 or send a 
  394. CompuServe mail message to the ASP Ombudsman (70007,3536). 
  395.  
  396.                        _______
  397.                   ____|__     |                (R)
  398.                --|       |    |-------------------
  399.                  |   ____|__  |  Association of
  400.                  |  |       |_|  Shareware
  401.                  |__|   o   |    Professionals
  402.                -----|   |   |---------------------
  403.                     |___|___|    MEMBER
  404.  
  405.  
  406.  
  407.          ----------------end-of-author's-documentation---------------
  408.  
  409.                          Software Library Information:
  410.  
  411.                     This disk copy provided as a service of
  412.  
  413.                            Public (software) Library
  414.  
  415.          We are not the authors of this program, nor are we associated
  416.          with the author in any way other than as a distributor of the
  417.          program in accordance with the author's terms of distribution.
  418.  
  419.          Please direct shareware payments and specific questions about
  420.          this program to the author of the program, whose name appears
  421.          elsewhere in  this documentation. If you have trouble getting
  422.          in touch with the author,  we will do whatever we can to help
  423.          you with your questions. All programs have been tested and do
  424.          run.  To report problems,  please use the form that is in the
  425.          file PROBLEM.DOC on many of our disks or in other written for-
  426.          mat with screen printouts, if possible.  PsL cannot debug pro-
  427.          programs over the telephone, though we can answer questions.
  428.  
  429.          Disks in the PsL are updated  monthly,  so if you did not get
  430.          this disk directly from the PsL, you should be aware that the
  431.          files in this set may no longer be the current versions. Also,
  432.          if you got this disk from another vendor and are having prob-
  433.          lems,  be aware that  some files may have become corrupted or
  434.          lost by that vendor. Get a current, working disk from PsL.
  435.  
  436.          For a copy of the latest monthly software library newsletter
  437.          and a list of the 3,000+ disks in the library, call or write
  438.  
  439.                            Public (software) Library
  440.                                P.O.Box 35705 - F
  441.                             Houston, TX 77235-5705
  442.  
  443.                                 1-800-2424-PSL
  444.                              MC/Visa/AmEx/Discover
  445.  
  446.                           Outside of U.S. or in Texas
  447.                           or for general information,
  448.                               Call 1-713-524-6394
  449.  
  450.                           PsL also has an outstanding
  451.                           catalog for the Macintosh.
  452.  
  453.